com.inscoper.api.Camera¶

Camera class defines the interface for camera devices. More...

Inherits from com.inscoper.api.AbstractSystem

Public Functions¶

	Name
synchronized void	delete()
long	getImageHeight() Get the image height.
long	getImageWidth() Get the image width.
long	getImageBitDepth() Get the image bit depth.
long	getBytesPerPixel() Get the number of bytes per pixel.
int	getImageBufferSize() Get the image buffer size.
long	getImageNumberPerTrigg() Get the number of acquired images per trigger.
long	getMaxNumberOfChannel() Get the maximum number of channels.
double	getExposure() Get the exposure time.
void	setExposure(double d) Set the exposure time.
String	getBinning() Get the binning mode.
void	setBinning(String binning) Set the binning mode.
boolean	isHardwareCropAvailable() Check if hardware ROI cropping is available.
void	setHardwareCrop(RoiCropVector crops) Set the hardware ROI crops.
RoiCropVector	getHardwareCrop() Get the hardware ROI crops.
boolean	isSequenceRunning() Check if a sequence is running.
void	prepareSequenceAcquisition() Prepare for sequence acquisition.
void	startSequenceAcquisition(long nbImage) Start a sequence acquisition.
void	startContinuousSequenceAcquisition() Start a continuous sequence acquisition.
void	checkSequenceStarted() Wait until the sequence starts.
void	softwareTriggerImage() Trigger an image acquisition bypassing the device controller (software trigger).
boolean	isSoftwareTriggerAvailable() Check if software trigger is available.
Image	snapImage(long chanIdx) Captures a single frame from the specified channel.
Image	popNextImage(long chanIdx) Pop the next acquired image.
Image	popNextImageBlocking(long chanIdx) Wait and pop the next acquired image.
Image	getLastImage(long chanIdx, long indexBeforeLastImg) Get the last acquired image.
Image	getLastImage(long chanIdx) Get the last acquired image.
int	getRemainingImageCount(long chanIdx) Get the number of images remaining in the buffer.
void	stopSequenceAcquisition() Stop the sequence acquisition.
void	clearBuffers() Clear internal buffers.

Protected Functions¶

	Name
	Camera(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Camera obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.api.AbstractSystem

	Name
EDeviceType	getDeviceType() Get the type of the device.
String	getLastError() Get the last error message.
StringVector	getProperties() Get the list of available properties.
SubDeviceIdVector	getModifiedProperties() Get the list of modified properties.
String	getProperty(String name) Get the value of a property.
void	setProperty(String name, String value) Set the value of a property.
void	checkProperty(String name) Check if a property value is valid.
boolean	isReadOnly(String propName) Check if a property is read-only.
EParamType	getType(String propName) Get the data type of a property.
String	getMin(String propName) Get the minimum value of a property.
String	getMax(String propName) Get the maximum value of a property.
String	getStep(String propName) Get the step size of a property.
StringVector	getValueList(String propName) Get the list of allowed values for a property.
boolean	isAccessibleInSequence(String propName) Check if a property is accessible during sequence execution.
int	getRealType()
AbstractSystem	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.api.AbstractSystem

	Name
	AbstractSystem(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.api.Camera;

Camera class defines the interface for camera devices.

This class extends AbstractSystem to provide image acquisition capabilities, controlling parameters such as exposure, binning, and ROIs, and managing acquisition sequences.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.api.AbstractSystem.delete

function getImageHeight¶

public long getImageHeight()

Get the image height.

Return: The image height

Retrieves the height of the acquired images in pixels.

function getImageWidth¶

public long getImageWidth()

Get the image width.

Return: The image width

Retrieves the width of the acquired images in pixels.

function getImageBitDepth¶

public long getImageBitDepth()

Get the image bit depth.

Return: The image bit depth

Retrieves the bit depth of the acquired images (e.g., 8, 12, 16 bits).

function getBytesPerPixel¶

public long getBytesPerPixel()

Get the number of bytes per pixel.

Return: The bytes per pixel

Retrieves the number of bytes used to store a single pixel in the acquired images.

function getImageBufferSize¶

public int getImageBufferSize()

Get the image buffer size.

Return: The image buffer size

Retrieves the total size of the image buffer in bytes.

function getImageNumberPerTrigg¶

public long getImageNumberPerTrigg()

Get the number of acquired images per trigger.

Return: The number of acquired images per trigger

Retrieves the number of frames acquired for each trigger event.

function getMaxNumberOfChannel¶

public long getMaxNumberOfChannel()

Get the maximum number of channels.

Return: The maximum number of channels

Retrieves the maximum number of channels supported by the camera.

function getExposure¶

public double getExposure()

Get the exposure time.

Return: The exposure time

Retrieves the current exposure time setting in micro seconds.

function setExposure¶

public void setExposure(
    double d
)

Set the exposure time.

Parameters:

d : The exposure time to set

Sets the exposure time for image acquisition, in micro seconds.

function getBinning¶

public String getBinning()

Get the binning mode.

Return: The binning mode

Retrieves the current binning configuration (e.g., "1x1", "2x2").

function setBinning¶

public void setBinning(
    String binning
)

Set the binning mode.

Parameters:

binning : The binning mode to set

Sets the binning configuration for image acquisition.

function isHardwareCropAvailable¶

public boolean isHardwareCropAvailable()

Check if hardware ROI cropping is available.

Return: True if hardware ROI cropping is available, false otherwise

Determines if the camera supports Region Of Interest (ROI) cropping in hardware.

function setHardwareCrop¶

public void setHardwareCrop(
    RoiCropVector crops
)

Set the hardware ROI crops.

Parameters:

crops : A list of hardware ROI crops

Configures the hardware regions of interest for acquisition.

function getHardwareCrop¶

public RoiCropVector getHardwareCrop()

Get the hardware ROI crops.

Return: A list of hardware ROI crops

Retrieves the currently configured hardware regions of interest.

function isSequenceRunning¶

public boolean isSequenceRunning()

Check if a sequence is running.

Return: True if a sequence is running, false otherwise

Determines if an image acquisition sequence is currently in progress.

function prepareSequenceAcquisition¶

public void prepareSequenceAcquisition()

Prepare for sequence acquisition.

Performs necessary setup steps before starting an acquisition sequence.

function startSequenceAcquisition¶

public void startSequenceAcquisition(
    long nbImage
)

Start a sequence acquisition.

Parameters:

nbImage : The number of images to acquire

Begins capturing a specified number of images. -1, is an infinite number of images.

function startContinuousSequenceAcquisition¶

public void startContinuousSequenceAcquisition()

Start a continuous sequence acquisition.

Begins capturing images continuously until stopped.

function checkSequenceStarted¶

public void checkSequenceStarted()

Wait until the sequence starts.

Wait until the acquisition sequence initiates.

function softwareTriggerImage¶

public void softwareTriggerImage()

Trigger an image acquisition bypassing the device controller (software trigger).

Sends a direct software command to capture an image, without the device controller.

function isSoftwareTriggerAvailable¶

public boolean isSoftwareTriggerAvailable()

Check if software trigger is available.

Return: True if software trigger is available, false otherwise

Determines if the camera supports direct triggering via software commands.

function snapImage¶

public Image snapImage(
    long chanIdx
)

Captures a single frame from the specified channel.

Parameters:

chanIdx : The index of the acquisition channel (0 for single-channel devices)

Return: The image

Initiates an image acquisition and retrieves the data from the requested channel index.

function popNextImage¶

public Image popNextImage(
    long chanIdx
)

Pop the next acquired image.

Parameters:

chanIdx : The index of the acquisition channel (0 for single-channel devices)

Return: The image

Acquired images are stored in an internal buffer. Retrieves the next available image from this buffer, for the requested channel index.

function popNextImageBlocking¶

public Image popNextImageBlocking(
    long chanIdx
)

Wait and pop the next acquired image.

Parameters:

chanIdx : The index of the acquisition channel (0 for single-channel devices)

Return: The image

Acquired images are stored in an internal buffer. Retrieves the next available image from this buffer, waiting if necessary until one becomes available, for the requested channel index.

function getLastImage¶

public Image getLastImage(
    long chanIdx,
    long indexBeforeLastImg
)

Get the last acquired image.

Parameters:

chanIdx : The index of the acquisition channel (0 for single-channel devices)
indexBeforeLastImg : Offset from the last image (0 for the very last)

Return: The image

Acquired images are stored in an internal buffer. Retrieves an image from this buffer based on its chronological order for the requested channel index.

function getLastImage¶

public Image getLastImage(
    long chanIdx
)

Get the last acquired image.

Parameters:

chanIdx : The index of the acquisition channel (0 for single-channel devices)

Return: The image

Acquired images are stored in an internal buffer. Retrieves an image from this buffer based on its chronological order for the requested channel index.

function getRemainingImageCount¶

public int getRemainingImageCount(
    long chanIdx
)

Get the number of images remaining in the buffer.

Parameters:

chanIdx : The index of the acquisition channel (0 for single-channel devices)

Return: The number of remaining images in the buffer

Retrieves the number of images currently waiting in the buffer.

function stopSequenceAcquisition¶

public void stopSequenceAcquisition()

Stop the sequence acquisition.

Stops the current image acquisition sequence.

function clearBuffers¶

public void clearBuffers()

Clear internal buffers.

Clears all images stored in the internal buffers.

Protected Functions Documentation¶

function Camera¶

protected Camera(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.api.AbstractSystem.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.api.AbstractSystem.finalize

function getCPtr¶

protected static long getCPtr(
    Camera obj
)

Updated on 2026-04-02 at 10:55:37 +0200